Use Jason.encode! when sending errors#161
Open
khaapamyaki wants to merge 3 commits into
Open
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
At the moment
Twirp.Plug.send_error/2usesTwirp.Encoder.encode/3for encoding the error.This leads to a problem where the
defimpl Jason.Encoderfor theTwirp.Errorstruct is not being used, and thus the:__exception__field is being sent with every error response.The twirp specification v7 describes how error responses must be encoded:
{ "code": "permission_denied", "msg": "Thou shall not pass", "meta": { "target": "Balrog", "power": "999" } }codeandmsgare required whilemetais optional.The twirp-elixir implementation will send the following:
{ "__exception__": true, "code": "permission_denied", "msg": "Thou shall not pass", "meta": { "target": "Balrog", "power": "999" } }The twirp go implementation is very strict about the errors
This leads the Go implementation to handle the error as if it originated from an intermediary (e.g. a reverse proxy) and translating the HTTP status code 404 as a bad_route instead of the original error.
This PR makes use of
Jason.encode!/1in theTwirp.Plug.send_error/2to fix this issue, as it will use the protocol implementation found inTwirp.Error.